NAVNavbar
Logo
cURL php NodeJS Python cSharp

Content Analysis API ID List

 
This endpoint is designed to provide you with the list of IDs and metadata of the completed Content Analysis tasks during the specified period. You will get all task IDs that were made including successful, uncompleted, and tasks that responded as errors.

Note that: You can set the date range within six months from the date of calling the endpoint. Metadata is only available for tasks that were made within one month.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to get a result
$post_array[] = array(
   "datetime_from" => "2023-01-31 00:00:00 +02:00",
   "datetime_to" => "2023-02-01 00:00:00 +02:00",
   "limit" => 100,
   "offset" => 0,
   "sort" => "desc"
   "include_metadata" => true
);
try {
   // POST /v3/content_analysis/id_list
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/content_analysis/id_list', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20221214",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.2774 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "02101810-4426-0533-0000-5acb7988dcab",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.2163 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "content_analysis",
        "id_list"
      ],
      "data": {
        "api": "content_analysis",
        "function": "id_list",
        "datetime_from": "2023-01-11 00:00:00 +02:00",
        "datetime_to": "2023-02-10 17:47:00 +02:00",
        "limit": 100,
        "sort": "desc",
        "include_metadata": true
      },
      "result": [
        {
          "id": "02101730-4426-0464-0000-df208d5c8e8e",
          "url": "v3/content_analysis/summary/live",
          "datetime_posted": "2023-02-10 15:30:24 +00:00",
          "datetime_done": "2023-02-10 15:30:24 +00:00",
          "status": "20000",
          "cost": 0.02003,
          "metadata": {
            "api": "content_analysis",
            "function": "summary",
            "keyword": "logitech",
            "search_mode": "as_is",
            "page_type": [
              "ecommerce",
              "news",
              "blogs",
              "message-boards",
              "organization"
            ],
            "internal_list_limit": 8,
            "positive_connotation_threshold": 0.5
          }
        }
      ]
    }
  ]
}

You can make up to 10 API calls per minute. With each API call, you can get 1000 task IDs within six previous month.

All POST data should be sent in JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.

Description of the fields for sending a request:

Field name Type Description
datetime_from string start time for filtering results
required field
if include_metadata is set to true, maximum value: a month from current datetime;
if include_metadata is set to false, maximum value: six months from current datetime;
must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2023-01-15 12:57:46 +00:00
datetime_to string finish time for filtering results
required field
maximum value: current datetime;
must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2023-01-31 13:57:46 +00:00
limit integer the maximum number of returned task IDs
optional field
default value: 1000
maximum value: 1000
offset integer offset in the results array of returned task IDs
optional field
default value: 0
if you specify the 10 value, the first ten tasks in the results array will be omitted
sort string sorting by task execution time
optional field
possible values: "asc", "desc"
default value: "asc"
include_metadata boolean include task metadata in the respond
optional field
default value: false

 
‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
status_message string general informational message
you can find the full list of general informational messages here
time string total execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO, can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            id string id of the task
            url string URL of the task
URL you used for making an API call
            datetime_posted string date and time when the task was made
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2023-01-15 12:57:46 +00:00
            datetime_done string date and time when the task was completed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2023-01-15 12:57:46 +00:00
            status string informational message of the task
you can find the full list of general informational messages here
            cost float cost of the task, USD
            metadata object contains parameters you specified in the POST request